<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    <title>Wi-Fi Host Driver (WHD): WHD Wi-Fi SoftAP API</title>
    <link href="tabs.css" rel="stylesheet" type="text/css"/>
    <script type="text/javascript" src="jquery.js"></script>
    <script type="text/javascript" src="dynsections.js"></script>
    <link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
    <link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="doxygen.css" rel="stylesheet" type="text/css" />
  </head>
  <body>
    <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
      <div id="titlearea" style="font-family:verdana;">
        <table border='0' cellpadding='0' cellspacing='0' width="98%">
          <tr style="height:20px"><td>&nbsp;</td></tr>
          <tr style="border-collapse: collapse; padding: 0;">
            <td style="width:20px"></td>
            <td style="width:117px"><img src="ifx_logo.png" alt="Infineon Logo" /></td>
            <td style="vertical-align:middle; text-align:center; font: bold 25px/100% Verdana, Arial, Helvetica, sans-serif;">
              Wi-Fi Host Driver (WHD) Public API Reference Guide
            </td>
          </tr>
          <tr><td>&nbsp;</td></tr>
        </table>
    </div>
    <!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__wifisoftap.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">WHD Wi-Fi SoftAP API<div class="ingroups"><a class="el" href="group__wifi.html">WHD Wi-Fi API</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>Wi-Fi APIs to perform SoftAP related functionalities. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaadae58f1d4df7841e8be7fafeae72450"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#gaadae58f1d4df7841e8be7fafeae72450">whd_wifi_init_ap</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *ssid, <a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> auth_type, const uint8_t *security_key, uint8_t key_length, uint16_t chanspec)</td></tr>
<tr class="memdesc:gaadae58f1d4df7841e8be7fafeae72450"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialises an infrastructure WiFi network (SoftAP)  <a href="#gaadae58f1d4df7841e8be7fafeae72450">More...</a><br /></td></tr>
<tr class="separator:gaadae58f1d4df7841e8be7fafeae72450"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa8dae2c15fc1b0ce7d7d25c1a0c94319"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#gaa8dae2c15fc1b0ce7d7d25c1a0c94319">whd_wifi_start_ap</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:gaa8dae2c15fc1b0ce7d7d25c1a0c94319"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the infrastructure WiFi network (SoftAP) using the parameter set by <a class="el" href="group__wifisoftap.html#gaadae58f1d4df7841e8be7fafeae72450" title="Initialises an infrastructure WiFi network (SoftAP)">whd_wifi_init_ap()</a> and optionaly by <a class="el" href="group__wifiutilities.html#ga8cb13597c33e7e8c0549e88c561129e1" title="Manage the addition and removal of custom IEs.">whd_wifi_manage_custom_ie()</a>  <a href="#gaa8dae2c15fc1b0ce7d7d25c1a0c94319">More...</a><br /></td></tr>
<tr class="separator:gaa8dae2c15fc1b0ce7d7d25c1a0c94319"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7d01b60b83e6130cbce31f21db00cef5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga7d01b60b83e6130cbce31f21db00cef5">whd_wifi_stop_ap</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp)</td></tr>
<tr class="memdesc:ga7d01b60b83e6130cbce31f21db00cef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops an existing infrastructure WiFi network.  <a href="#ga7d01b60b83e6130cbce31f21db00cef5">More...</a><br /></td></tr>
<tr class="separator:ga7d01b60b83e6130cbce31f21db00cef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga85719f47f4eb9eed7cc1a8e76f573432"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga85719f47f4eb9eed7cc1a8e76f573432">whd_wifi_ap_get_max_assoc</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint32_t *max_assoc)</td></tr>
<tr class="memdesc:ga85719f47f4eb9eed7cc1a8e76f573432"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the maximum number of associations supported by AP interfaces.  <a href="#ga85719f47f4eb9eed7cc1a8e76f573432">More...</a><br /></td></tr>
<tr class="separator:ga85719f47f4eb9eed7cc1a8e76f573432"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga28218244e640e2821e7832d23b75d33f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga28218244e640e2821e7832d23b75d33f">whd_wifi_get_associated_client_list</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, void *client_list_buffer, uint16_t buffer_length)</td></tr>
<tr class="memdesc:ga28218244e640e2821e7832d23b75d33f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current number of active connections.  <a href="#ga28218244e640e2821e7832d23b75d33f">More...</a><br /></td></tr>
<tr class="separator:ga28218244e640e2821e7832d23b75d33f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea93b14e2dee42b32029d0ec3990ff86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#gaea93b14e2dee42b32029d0ec3990ff86">whd_wifi_deauth_sta</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, <a class="el" href="structwhd__mac__t.html">whd_mac_t</a> *mac, <a class="el" href="whd__types_8h.html#ac81b31559ee1db82f01e8acfb8eea55d">whd_dot11_reason_code_t</a> reason)</td></tr>
<tr class="memdesc:gaea93b14e2dee42b32029d0ec3990ff86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deauthenticates a STA which may or may not be associated to SoftAP.  <a href="#gaea93b14e2dee42b32029d0ec3990ff86">More...</a><br /></td></tr>
<tr class="separator:gaea93b14e2dee42b32029d0ec3990ff86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4b7b3b58a4bcc68a642091c817bd32af"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga4b7b3b58a4bcc68a642091c817bd32af">whd_wifi_get_ap_info</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, whd_bss_info_t *ap_info, <a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> *security)</td></tr>
<tr class="memdesc:ga4b7b3b58a4bcc68a642091c817bd32af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves AP information.  <a href="#ga4b7b3b58a4bcc68a642091c817bd32af">More...</a><br /></td></tr>
<tr class="separator:ga4b7b3b58a4bcc68a642091c817bd32af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2b2b514109551abf57e79d0233818497"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga2b2b514109551abf57e79d0233818497">whd_wifi_ap_set_beacon_interval</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint16_t interval)</td></tr>
<tr class="memdesc:ga2b2b514109551abf57e79d0233818497"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the beacon interval.  <a href="#ga2b2b514109551abf57e79d0233818497">More...</a><br /></td></tr>
<tr class="separator:ga2b2b514109551abf57e79d0233818497"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga48ea6684564b9b79cfbbdf60916ce5c9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wifisoftap.html#ga48ea6684564b9b79cfbbdf60916ce5c9">whd_wifi_ap_set_dtim_interval</a> (<a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a> ifp, uint16_t interval)</td></tr>
<tr class="memdesc:ga48ea6684564b9b79cfbbdf60916ce5c9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the DTIM interval.  <a href="#ga48ea6684564b9b79cfbbdf60916ce5c9">More...</a><br /></td></tr>
<tr class="separator:ga48ea6684564b9b79cfbbdf60916ce5c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaadae58f1d4df7841e8be7fafeae72450"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaadae58f1d4df7841e8be7fafeae72450">&#9670;&nbsp;</a></span>whd_wifi_init_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_init_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structwhd__ssid__t.html">whd_ssid_t</a> *&#160;</td>
          <td class="paramname"><em>ssid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a>&#160;</td>
          <td class="paramname"><em>auth_type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const uint8_t *&#160;</td>
          <td class="paramname"><em>security_key</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t&#160;</td>
          <td class="paramname"><em>key_length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>chanspec</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialises an infrastructure WiFi network (SoftAP) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ssid</td><td>A null terminated string containing the SSID name of the network to join </td></tr>
    <tr><td class="paramname">auth_type</td><td>Authentication type </td></tr>
    <tr><td class="paramname">security_key</td><td>A byte array containing the cleartext security key for the network </td></tr>
    <tr><td class="paramname">key_length</td><td>The length of the security_key in bytes. </td></tr>
    <tr><td class="paramname">chanspec</td><td>The desired chanspec</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if successfully initialises an AP Error code if an error occurred </dd></dl>

</div>
</div>
<a id="gaa8dae2c15fc1b0ce7d7d25c1a0c94319"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa8dae2c15fc1b0ce7d7d25c1a0c94319">&#9670;&nbsp;</a></span>whd_wifi_start_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_start_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start the infrastructure WiFi network (SoftAP) using the parameter set by <a class="el" href="group__wifisoftap.html#gaadae58f1d4df7841e8be7fafeae72450" title="Initialises an infrastructure WiFi network (SoftAP)">whd_wifi_init_ap()</a> and optionaly by <a class="el" href="group__wifiutilities.html#ga8cb13597c33e7e8c0549e88c561129e1" title="Manage the addition and removal of custom IEs.">whd_wifi_manage_custom_ie()</a> </p>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if successfully creates an AP Error code if an error occurred </dd></dl>

</div>
</div>
<a id="ga7d01b60b83e6130cbce31f21db00cef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7d01b60b83e6130cbce31f21db00cef5">&#9670;&nbsp;</a></span>whd_wifi_stop_ap()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_stop_ap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stops an existing infrastructure WiFi network. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the AP is successfully stopped or if the AP has not yet been brought up Error code if an error occurred </dd></dl>

</div>
</div>
<a id="ga85719f47f4eb9eed7cc1a8e76f573432"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga85719f47f4eb9eed7cc1a8e76f573432">&#9670;&nbsp;</a></span>whd_wifi_ap_get_max_assoc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_ap_get_max_assoc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>max_assoc</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the maximum number of associations supported by AP interfaces. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">max_assoc</td><td>The maximum number of associations supported by Soft AP interfaces.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the maximum number of associated clients was successfully read WHD_ERROR if the maximum number of associated clients was not successfully read </dd></dl>

</div>
</div>
<a id="ga28218244e640e2821e7832d23b75d33f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga28218244e640e2821e7832d23b75d33f">&#9670;&nbsp;</a></span>whd_wifi_get_associated_client_list()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_get_associated_client_list </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>client_list_buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>buffer_length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the current number of active connections. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">client_list_buffer</td><td>Buffer to store list of associated clients </td></tr>
    <tr><td class="paramname">buffer_length</td><td>Length of client list buffer</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the active connections was successfully read WHD_ERROR if the active connections was not successfully read </dd></dl>

</div>
</div>
<a id="gaea93b14e2dee42b32029d0ec3990ff86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea93b14e2dee42b32029d0ec3990ff86">&#9670;&nbsp;</a></span>whd_wifi_deauth_sta()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_deauth_sta </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structwhd__mac__t.html">whd_mac_t</a> *&#160;</td>
          <td class="paramname"><em>mac</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#ac81b31559ee1db82f01e8acfb8eea55d">whd_dot11_reason_code_t</a>&#160;</td>
          <td class="paramname"><em>reason</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deauthenticates a STA which may or may not be associated to SoftAP. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">mac</td><td>Pointer to a variable containing the MAC address to which the deauthentication will be sent NULL mac address will deauthenticate all the associated STAs</td></tr>
    <tr><td class="paramname">reason</td><td>Deauthentication reason code</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS On successful deauthentication of the other STA WHD_ERROR If an error occurred </dd></dl>

</div>
</div>
<a id="ga4b7b3b58a4bcc68a642091c817bd32af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4b7b3b58a4bcc68a642091c817bd32af">&#9670;&nbsp;</a></span>whd_wifi_get_ap_info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_get_ap_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">whd_bss_info_t *&#160;</td>
          <td class="paramname"><em>ap_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="whd__types_8h.html#aaeeea5666743710aa4f01ff264b27059">whd_security_t</a> *&#160;</td>
          <td class="paramname"><em>security</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves AP information. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">ap_info</td><td>Returns a whd_bss_info_t structure containing AP details </td></tr>
    <tr><td class="paramname">security</td><td>Authentication type</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS if the AP info was successfully retrieved Error code if the AP info was not successfully retrieved </dd></dl>

</div>
</div>
<a id="ga2b2b514109551abf57e79d0233818497"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2b2b514109551abf57e79d0233818497">&#9670;&nbsp;</a></span>whd_wifi_ap_set_beacon_interval()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_ap_set_beacon_interval </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>interval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the beacon interval. </p>
<p>Note that the value needs to be set before ap_start in order to beacon interval to take effect.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">interval</td><td>Beacon interval in time units (Default: 100 time units = 102.4 ms)</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
<a id="ga48ea6684564b9b79cfbbdf60916ce5c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga48ea6684564b9b79cfbbdf60916ce5c9">&#9670;&nbsp;</a></span>whd_wifi_ap_set_dtim_interval()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="whd__types_8h.html#add62f4b5040a2451e23869d2f9e1ae05">whd_result_t</a> whd_wifi_ap_set_dtim_interval </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="whd_8h.html#a2e544c482ddbb690bbb95ce7174e79a0">whd_interface_t</a>&#160;</td>
          <td class="paramname"><em>ifp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>interval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the DTIM interval. </p>
<p>Note that the value needs to be set before ap_start in order to DTIM interval to take effect.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ifp</td><td>Pointer to handle instance of whd interface </td></tr>
    <tr><td class="paramname">interval</td><td>DTIM interval, in unit of beacon interval</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>WHD_SUCCESS or Error code </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
    <!-- start footer part -->
    <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
      <ul>
        <li class="footer">Copyright Infineon Technologies.</li>
      </ul>
    </div>
  </body>
</html>
